@smithy/eventstream-serde-node

What is @smithy/eventstream-serde-node?

@smithy/eventstream-serde-node is a package designed to handle serialization and deserialization of event streams in Node.js. It is part of the AWS SDK for JavaScript and is used to process event streams, which are sequences of events that can be transmitted over a network connection.

What are @smithy/eventstream-serde-node's main functionalities?

Serialization of Event Streams

This feature allows you to serialize an event stream into a format suitable for transmission. The code sample demonstrates how to create an instance of EventStreamMarshaller and use it to serialize an event.

const { EventStreamMarshaller } = require('@smithy/eventstream-serde-node');
const marshaller = new EventStreamMarshaller();
const event = { eventType: 'example', data: 'sample data' };
const serializedEvent = marshaller.marshall(event);
console.log(serializedEvent);

Deserialization of Event Streams

This feature allows you to deserialize an event stream back into its original format. The code sample shows how to use the EventStreamMarshaller to deserialize a serialized event.

const { EventStreamMarshaller } = require('@smithy/eventstream-serde-node');
const marshaller = new EventStreamMarshaller();
const serializedEvent = /* some serialized event data */;
const event = marshaller.unmarshall(serializedEvent);
console.log(event);

Other packages similar to @smithy/eventstream-serde-node

event-stream

The 'event-stream' package provides a toolkit for working with streams in Node.js. It includes utilities for creating, manipulating, and consuming streams. While it is more general-purpose compared to @smithy/eventstream-serde-node, it can be used to handle event streams in a similar manner.

stream-json

The 'stream-json' package is designed for processing JSON streams in Node.js. It provides tools for parsing and stringifying JSON data in a streaming fashion. Although it is focused on JSON, it offers similar functionality for handling streaming data as @smithy/eventstream-serde-node.

node-eventstore-client

The 'node-eventstore-client' package is a client for EventStore, a database optimized for event sourcing. It provides APIs for reading and writing event streams to an EventStore database. This package is more specialized compared to @smithy/eventstream-serde-node, focusing on integration with EventStore.

README

@smithy/eventstream-serde-node

An internal package

Usage

You probably shouldn't, at least directly.